Embabel Agent Documentation/com.embabel.agent.rag

Package-level declarations

Types

AbstractWritableContentElementRepository

abstract class AbstractWritableContentElementRepository(chunkerConfig: ContentChunker.Config) : WritableContentElementRepository

Convenience base class for WritableRagService implementations.

Chunk

interface Chunk : Source, HierarchicalContentElement

Traditional RAG. Text chunk

Cluster

data class Cluster<E>(val anchor: E, val similar: List<<Error class: unknown class><E>>)

Cluster of similar things

ClusterFinder

interface ClusterFinder

ClusterRetrievalRequest

data class ClusterRetrievalRequest<E> constructor(val entitySearch: EntitySearch? = null, val contentElementSearch: ContentElementSearch = ContentElementSearch.NONE, val similarityThreshold: <Error class: unknown class> = 0.7, val topK: Int = 10, val vectorIndex: String = "embabel-entity-index") : RetrievalFilters<ClusterRetrievalRequest<E>>

CompressionConfig

open class CompressionConfig(val enabled: Boolean = true)

ContainerSection

interface ContainerSection : Section

ContentElement

interface ContentElement : Datum

Structural content element that may have a parent and children. Textual.

ContentElementSearch

data class ContentElementSearch(val types: List<Class<out ContentElement>>)

ContentRoot

interface ContentRoot : HierarchicalContentElement

Root of a structured document It must have a non-null URI

ContextualTool

data class ContextualTool(val toolCallback: <Error class: unknown class>) : Retrievable

Tool retrieved by a RAG request

Datum

sealed interface Datum

Data object instance, whether structural or not.

DepthExplorationRequest

data class DepthExplorationRequest(val depth: Int) : ExplorationRequest

Embeddable

interface Embeddable

Embedded

interface Embedded

Embedded object instance.

EnhancementEstimate

data class EnhancementEstimate(val expectedQualityGain: Double, val estimatedLatencyMs: Long, val estimatedTokenCost: Int, val recommendation: EnhancementRecommendation)

EnhancementRecommendation

enum EnhancementRecommendation : Enum<EnhancementRecommendation>

EnhancementType

enum EnhancementType : Enum<EnhancementType>

EntityData

interface EntityData : RetrievableEntity

Generic retrieved entity

EntitySearch

open class EntitySearch(val labels: Set<String>, val generateQueries: Boolean = false)

Controls entity search Open to allow specializations

ExplorationRequest

sealed interface ExplorationRequest

Fact

data class Fact(val assertion: String, val authority: String, val uri: String? = null, val metadata: Map<String, Any?> = emptyMap(), val id: String = UUID.randomUUID().toString()) : Source

A fact.

HierarchicalContentElement

interface HierarchicalContentElement : ContentElement

ContentElement that exists in a hierarchy, such as a document with sections and subsections.

HyDE

data class HyDE constructor(val wordCount: Int = 50)

Hypothetical Document Embedding Used to generate a synthetic document for embedding from the query.

LeafSection

data class LeafSection(val id: String, val uri: String? = null, val title: String, val text: String, val parentId: String? = null, val metadata: Map<String, Any?> = emptyMap()) : MaterializedSection, HasContent

Contains content

MaterializedSection

interface MaterializedSection : Section

NamedEntityData

interface NamedEntityData : EntityData

Adds a name to the well known entity data.

NavigableRagService

@ApiStatus.Experimental

interface NavigableRagService : RagService

Rag service that supports navigation in a graph of retrievable objects. This may not be supported by all RAG services. It need not be a graph but could be implemented by a relational database or other structure.

PathsExplorationRequest

data class PathsExplorationRequest(val paths: List<String>) : ExplorationRequest

PromptRunnerRagResponseSummarizer

class PromptRunnerRagResponseSummarizer(val promptRunner: PromptRunner, val options: RagOptions) : RagResponseSummarizer

QualityMetrics

data class QualityMetrics(val faithfulness: <Error class: unknown class>, val answerRelevancy: <Error class: unknown class>, val contextPrecision: <Error class: unknown class>, val contextRecall: <Error class: unknown class>, val contextRelevancy: <Error class: unknown class>, val overallScore: <Error class: unknown class> = computeRAGASScore( faithfulness, answerRelevancy, contextPrecision, contextRecall, contextRelevancy, ))

RAGAS quality metrics

RagRequest

data class RagRequest(val query: String, val similarityThreshold: <Error class: unknown class> = 0.8, val topK: Int = 8, val hyDE: HyDE? = null, val desiredMaxLatency: Duration = Duration.ofMillis(5000), val compressionConfig: CompressionConfig = CompressionConfig(), val contentElementSearch: ContentElementSearch = ContentElementSearch.CHUNKS_ONLY, val entitySearch: EntitySearch? = null, val timestamp: Instant = Instant.now()) : RagRequestRefinement<RagRequest>

RAG request. Contains a query and parameters for similarity search.

RagRequestRefinement

interface RagRequestRefinement<T : RagRequestRefinement<T>> : RetrievalFilters<T>

Narrowing of RagRequest

RagResponse

data class RagResponse(val request: RagRequest, val service: String, val results: List<<Error class: unknown class><out Retrievable>>, val enhancement: RagResponseEnhancement? = null, val qualityMetrics: QualityMetrics? = null, val timestamp: Instant = Instant.now())

Rag response RagResponses can contain results from multiple RAG services. Results are not necessarily chunks, but can be entities.

RagResponseEnhancement

data class RagResponseEnhancement(val enhancer: RagResponseEnhancer, val basis: RagResponse, val processingTimeMs: Long = 0, val tokensProcessed: Int = 0, val enhancementType: EnhancementType, val qualityImpact: <Error class: unknown class>? = null)

RagResponseEnhancer

interface RagResponseEnhancer

RagResponseFormatter

fun interface RagResponseFormatter

Implemented by classes that can format RagResponse objects into a string for inclusion in tool responses or prompts.

RagResponseSummarizer

interface RagResponseSummarizer

RagService

interface RagService

Central interface for Retrieval-Augmented Generation (RAG) services. Returns entities as well as text chunks.

RagServiceEnhancer

interface RagServiceEnhancer

RagServiceEnhancerProperties

data class RagServiceEnhancerProperties(val compressionLlm: <Error class: unknown class> = LlmOptions.withAutoLlm(), val rerankingLlm: <Error class: unknown class> = LlmOptions.withAutoLlm(), val maxConcurrency: Int = 12)

Retrievable

interface Retrievable : Datum, Embeddable

A Retrievable object instance is a Datum (normally a chunk or an entity) that can be retrieved by RAG. It has a stable id.

RetrievableEntity

interface RetrievableEntity : Retrievable

Any retrievable entity, whether mapped or generic.

RetrievalFilters

interface RetrievalFilters<T : RetrievalFilters<T>>

Section

sealed interface Section : HierarchicalContentElement

SimpleEntityData

data class SimpleEntityData(val id: String, val uri: String? = null, val labels: Set<String>, val properties: Map<String, Any>, val metadata: Map<String, Any?> = emptyMap()) : EntityData

SimpleNamedEntityData

data class SimpleNamedEntityData(val id: String, val uri: String? = null, val name: String, val description: String, val labels: Set<String>, val properties: Map<String, Any>, val metadata: Map<String, Any?> = emptyMap()) : NamedEntityData

SimpleRagResponseFormatter

object SimpleRagResponseFormatter : RagResponseFormatter

Sensible default RagResponseFormatter

Source

sealed interface Source : Retrievable

A Source object instance is an input such as a Chunk or a Fact. It was provided to the system as data; it is not inferred by the system, but a direct piece of data.

Sourced

interface Sourced

Implemented by objects that are from a source.

TypedEntitySearch

open class TypedEntitySearch(val entities: List<Class<*>>, val generateQueries: Boolean = false) : EntitySearch

WritableContentElementRepository

interface WritableContentElementRepository : WritableStore, ContentElementRepository

WritableRagService that also allows us to load and save ContentElements.

WritableStore

interface WritableStore

RagService that can accept documents

Functions

computeRAGASScore

fun computeRAGASScore(faithfulness: Double, answerRelevancy: Double, contextPrecision: Double, contextRecall: Double, contextRelevancy: Double): Double